/**
 * This file is part of 1genia trampoline
 * Copyright (C) 2007 1genia (contact@1genia.com)
 *
 * This library is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; version 3 of the License. 
 *
 * This library is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details. 
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; see the file COPYING.TXT.  If not,
 * write to the Free Software Foundation, Inc., 51 Franklin Street,
 * Fifth Floor, Boston, MA 02110-1301, USA. 
 **/
package com.genia.toolbox.uml_generator.model.impl;

import java.util.ArrayList;
import java.util.List;

import com.genia.toolbox.basics.exception.BundledException;
import com.genia.toolbox.uml_generator.manager.ModelDecorator;
import com.genia.toolbox.uml_generator.model.AbstractClassModel;
import com.genia.toolbox.uml_generator.model.EnumerationLiteralModel;
import com.genia.toolbox.uml_generator.model.EnumerationModel;
import com.genia.toolbox.uml_generator.visitor.ModelVisitor;

/**
 * this class represent the Enumeration entities from the xmi file.
 */
public class EnumerationModelImpl
    extends AbstractDelegatableObjectImpl
    implements EnumerationModel
{

  /**
   * the {@link ModelDecorator} to use.
   */
  private ModelDecorator modelDecorator;



  /**
   * returns the qualified name to use in the hibernate mapping file.
   * 
   * @return the qualified name to use in the hibernate mapping file
   */
  @Override
  public String getHibernateQualifiedName()
  {
    return getModelDecorator().getMappingObject(this).getQualifiedName();
  }

  /**
   * instance of the neumerationModel.
   */
  private final List<EnumerationLiteralModel> enumerationLiteralModel = new ArrayList<EnumerationLiteralModel>();



  /**
   * returns the {@link List} of {@link EnumerationModel} representing the
   * different values of the enumeration.
   * 
   * @return the enumerationLiteralModel
   * @see com.genia.toolbox.uml_generator.model.EnumerationModel#getEnumerationLiteralModel()
   */
  public List<EnumerationLiteralModel> getEnumerationLiteralModel()
  {
    return enumerationLiteralModel;
  }



  /**
   * add instance of enumerationModel.
   * 
   * @param enumLiteralModel
   *          instance of enumerationModel.
   * @see com.genia.toolbox.uml_generator.model.EnumerationModel#addEnumerationLiteralModel(com.genia.toolbox.uml_generator.model.EnumerationLiteralModel)
   */
  public void addEnumerationLiteralModel(final EnumerationLiteralModel enumLiteralModel)
  {
    this.enumerationLiteralModel.add(enumLiteralModel);

  }



  /**
   * the actual visitor method.
   * 
   * @param modelVisitor
   *          the visitor to use
   * @throws BundledException
   *           when an error occurred
   * @see com.genia.toolbox.uml_generator.visitor.Visitable#visit(com.genia.toolbox.uml_generator.visitor.ModelVisitor)
   */
  public void visit(ModelVisitor modelVisitor)
      throws BundledException
  {
    modelVisitor.visitEnumerationModel(this);
  }



  /**
   * returns the parent of the enumeration which is *ALWAYS* <code>null</code>.
   * 
   * @return the parent of the enumeration which is *ALWAYS* <code>null</code>
   * @see com.genia.toolbox.uml_generator.model.AbstractDelegatableObject#getParent()
   */
  public AbstractClassModel getParent()
  {
    return null;
  }



  /**
   * getter for the modelDecorator property.
   * 
   * @return the modelDecorator
   */
  public ModelDecorator getModelDecorator()
  {
    return modelDecorator;
  }



  /**
   * setter for the modelDecorator property.
   * 
   * @param modelDecorator
   *          the modelDecorator to set
   */
  public void setModelDecorator(ModelDecorator modelDecorator)
  {
    this.modelDecorator = modelDecorator;
  }

}
